Button Alarm Click Driver

API for configuring and manipulating Button Alarm Click driver. More...

Topics
	Button Alarm PWM Settings
	Settings for configuration of Button Alarm Click driver.
	Button Alarm MikroBUS Map
	MikroBUS pin mapping of Button Alarm Click driver.
	Buttonalarm_cfg

Functions
void	buttonalarm_cfg_setup (buttonalarm_cfg_t *cfg)
	Button Alarm configuration object setup function.
err_t	buttonalarm_init (buttonalarm_t *ctx, buttonalarm_cfg_t *cfg)
	Button Alarm initialization function.
err_t	buttonalarm_set_duty_cycle (buttonalarm_t *ctx, float duty_cycle)
	Button Alarm sets PWM duty cycle.
err_t	buttonalarm_pwm_stop (buttonalarm_t *ctx)
	Button Alarm stop PWM module.
err_t	buttonalarm_pwm_start (buttonalarm_t *ctx)
	Button Alarm start PWM module.
uint8_t	buttonalarm_get_button_state (buttonalarm_t *ctx)
	Button Alarm get button state function.

Detailed Description

API for configuring and manipulating Button Alarm Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

buttonalarm_cfg_setup()

void buttonalarm_cfg_setup

(

buttonalarm_cfg_t *

cfg

)

Button Alarm configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See buttonalarm_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

buttonalarm_get_button_state()

uint8_t buttonalarm_get_button_state

(

buttonalarm_t *

ctx

)

Button Alarm get button state function.

This function reads the digital signal from the INT pin which tells us whether the button has been pressed or not.

Parameters

[out]

ctx

: Click context object. See buttonalarm_t object definition for detailed explanation.

Returns

Function returns pin logical state (1 or 0).

See #err_t definition for detailed explanation.

Note

None.

buttonalarm_init()

err_t buttonalarm_init	(	buttonalarm_t *	ctx,
		buttonalarm_cfg_t *	cfg )

Button Alarm initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See buttonalarm_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See buttonalarm_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonalarm_pwm_start()

err_t buttonalarm_pwm_start

(

buttonalarm_t *

ctx

)

Button Alarm start PWM module.

This function starts the PWM moudle output.

Parameters

[out]

ctx

: Click context object. See buttonalarm_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonalarm_pwm_stop()

err_t buttonalarm_pwm_stop

(

buttonalarm_t *

ctx

)

Button Alarm stop PWM module.

This function stops the PWM moudle output.

Parameters

[out]

ctx

: Click context object. See buttonalarm_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.

buttonalarm_set_duty_cycle()

err_t buttonalarm_set_duty_cycle	(	buttonalarm_t *	ctx,
		float	duty_cycle )

Button Alarm sets PWM duty cycle.

This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).

Parameters

[out]	ctx	: Click context object. See buttonalarm_t object definition for detailed explanation.
[in]	duty_ratio	: PWM duty_ratio.

Returns

• 0 - Success,
• -1 - Error.

See #err_t definition for detailed explanation.

Note

None.